Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add toolkit content #673

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

add toolkit content #673

wants to merge 3 commits into from

Conversation

brimigs
Copy link
Collaborator

@brimigs brimigs commented Dec 20, 2024

Summary of Changes

Added content for a Solana Developers Toolkit

Fixes #

@brimigs brimigs requested a review from ZYJLiu as a code owner December 20, 2024 17:12
The Solana Toolkit consists of all open sourced tools for smart contract
development on the Solana Blockchain.

You can contribute to this book on [GitHub]().
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can contribute to this book on [GitHub]().
You can contribute to this book on
[GitHub](https://github.com/solana-foundation/developer-content/tree/main/docs/toolkit).

### General Smart Contract Scaffold - Create Solana Program

```shell
pnpm create solana-program
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not everyone has pnpm installed, but node ships with npx by default. so lets use npx in this doc. devs that want to use pnpm will know how to modify this as needed

Suggested change
pnpm create solana-program
npx create-solana-program

Comment on lines +198 to +199
pnpm install
pnpm generate
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
pnpm install
pnpm generate
npm install
npm dev generate


4. Ensure your program’s `Cargo.toml` contains the following metadata:

```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```
```toml filename="Cargo.toml"

Comment on lines +408 to +412
```
pnpm install
pnpm programs:build
pnpm generate
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```
pnpm install
pnpm programs:build
pnpm generate
```
```shell
npm install
npm run programs:build
npm run generate

### Code Coverage Tool

```shell
npx solana coverage
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
npx solana coverage
mucho coverage

### JavaScript Testing Framework

```shell
npm install solana-bankrun
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
npm install solana-bankrun
npm install solana-bankrun

solana-test-validator
```

Advantages #
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Advantages #
### Advantages

Comment on lines +663 to +665
```shell
solana-test-validator
```
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
```shell
solana-test-validator
```
```shell
solana-test-validator

You can also use the mucho CLI as a superset of solana-test-validator:

mucho validator

To start your local validator, simply run:

```shell
solana-test-validator
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want to use mucho validator here instead?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants